com.inscoper.api.Bridge¶

The Bridge class is the main class of The Inscoper API. More...

Public Functions¶

	Name
synchronized void	delete()
Object	getValue(SubDeviceId subDeviceId)
	Bridge() Default constructor.
void	setLibraryPaths(StringVector libraryPaths) Set the library paths where to find external libraries (MicroManager, Custom driver etc).
void	loadConfigFile(String path) Load configuration based on its file path.
void	loadConfigFile() Load configuration based on its file path.
Config	readConfigFile(String path) Read the configuration file and return the corresponding configuration.
Config	readConfigFile() Read the configuration file and return the corresponding configuration.
void	loadConfig(Config config) Load the configuration.
void	saveConfig(String path, Config config) Save the configuration to an XML file.
void	saveCurrentConfig(String path) Save the current loaded configuration to an XML file.
void	saveCurrentConfig() Save the current loaded configuration to an XML file.
RecipeVector	readRecipeFile(String path) Read the recipe file and return the list of corresponding recipes.
RecipeVector	readRecipeFile() Read the recipe file and return the list of corresponding recipes.
void	saveRecipes(String path, RecipeVector recipes) Save the list of recipes to an XML file.
void	initDevices() Initialize all the loaded devices.
void	initDevice(String deviceId) Initialize a specific device.
void	initDevices(StringVector deviceIdList) Initialize a list of devices.
StringVector	getLoadedDevices() Get the list of IDs of all loaded devices.
StringVector	getInitializedDevices() Get the list of IDs of all initialized devices.
SubDeviceIdVector	getInitializedSubDeviceIds() Get the list of sub-device IDs for all initialized sub-devices.
boolean	closeDevices() Close all the loaded devices.
boolean	closeDevice(String deviceId) Close a specific device.
boolean	closeDevices(StringVector deviceIdList) Close a list of devices.
void	close() Close all the initialized devices, loaded drivers and more.
DeviceDescriptionVector	getDeviceDescriptionList() Get the device description list of all the available drivers (Inscoper Box, Micro Manager and Custom drivers).
DeviceDescriptionVector	loadDeviceDescriptionList(String filename) Load the device description list from a file.
void	saveDeviceDescriptionList(DeviceDescriptionVector deviceDescriptionList, String filename) Save the device description list to a file.
Status	loadSequence(int sequenceNumber, String recipeName, String paramsFile, Status currentStatus, int printIndex, SequenceHandler handler) Load a sequence with user params.
Status	loadSequence(int sequenceNumber, String recipeName, String paramsFile, Status currentStatus, int printIndex) Load a sequence with user params.
Status	loadSequence(int sequenceNumber, String recipeName, String paramsFile, Status currentStatus) Load a sequence with user params.
Status	loadSequence(int sequenceNumber, String recipeName, String paramsFile) Load a sequence with user params.
Status	loadSequence(int sequenceNumber, String recipeName, DimensionVector dimensionList, Status currentStatus, int printIndex, SequenceHandler handler) Load a sequence with dimensions.
Status	loadSequence(int sequenceNumber, String recipeName, DimensionVector dimensionList, Status currentStatus, int printIndex) Load a sequence with dimensions.
Status	loadSequence(int sequenceNumber, String recipeName, DimensionVector dimensionList, Status currentStatus) Load a sequence with dimensions.
Status	loadSequence(int sequenceNumber, String recipeName, DimensionVector dimensionList) Load a sequence with dimensions.
Status	loadSequence(int sequenceNumber, String recipeName, StatusVector statusList, Status currentStatus, int printIndex, SequenceHandler handler) Load a sequence with status list.
Status	loadSequence(int sequenceNumber, String recipeName, StatusVector statusList, Status currentStatus, int printIndex) Load a sequence with status list.
Status	loadSequence(int sequenceNumber, String recipeName, StatusVector statusList, Status currentStatus) Load a sequence with status list.
Status	loadSequence(int sequenceNumber, String recipeName, StatusVector statusList) Load a sequence with status list.
void	runSequence(int sequenceNumber, boolean async) Run a preloaded sequence.
void	runSequence(int sequenceNumber) Run a preloaded sequence.
void	waitUntilSequenceFinished(int sequenceNumber) Wait for the sequence to finish.
void	pauseSequence(int sequenceNumber) Pause the running sequence.
void	continueSequence(int sequenceNumber) Continue the paused sequence.
void	stopSequence(int sequenceNumber) Stop the running sequence.
void	removeSequence(int sequenceNumber) Remove the loaded sequence.
void	modifySequence(int sequenceNumber, UIntVector modifierIndexes) Modify the loaded sequence.
Status	addBackgroundSequence(int sequenceIndex, String recipeName, String paramsFile) Add a background sequence with params file.
Status	addBackgroundSequence(int sequenceIndex, String recipeName, DimensionVector dimensionList) Add a background sequence with dimension list.
Status	addBackgroundSequence(int sequenceIndex, String recipeName, StatusVector statusList) Add a background sequence with status list.
void	removeBackgroundSequence(int sequenceIndex) Remove a background sequence.
void	addSequenceListener(SequenceListener listener) Add a sequence listener to the API.
void	removeSequenceListener(SequenceListener listener) Remove a sequence listener from the API.
void	addAbstractSubDevice(AbstractSubDevice subDevice) Add an abstract sub device.
void	removeAbstractSubDevice(SubDeviceId subDeviceId) Remove an abstract sub device.
Camera	getCamera(String id) Get a camera device.
boolean	isHardwareCropAvailable(String id) Check if hardware crop is available for a camera.
void	setHardwareCrop(String id, RoiCropVector crops) Set hardware crop for a camera.
RoiCropVector	getHardwareCrop(String id) Get the current hardware crop configuration for a camera.
void	createTimeDevice(int index, String startRecipeId, String waitRecipeId) Create a time device.
void	createTimeDevice(int index, String startRecipeId) Create a time device.
void	createTimeDevice(int index) Create a time device.
SubDeviceId	getStartTimerSubDeviceId(int index) Get the sub-device ID for the start timer.
SubDeviceId	getWaitTimerSubDeviceId(int index) Get the sub-device ID for the wait timer.
DiagResults	runDeviceDiagnosis(DeviceDescription deviceDesc, DriverConfig driverConfig) Run diagnosis on a device.
void	saveDiagResults(DiagResults diagResults, String filename) Save diagnosis results to a file.
DiagResults	loadDiagResults(String filename) Load diagnosis results from a file.
void	saveDiagResultsList(DiagResultsVector diagResultsList, String filename) Save a list of diagnosis results to a file.
DiagResultsVector	loadDiagResultsList(String filename) Load a list of diagnosis results from a file.
SubDeviceIdVector	getValueConditionChildren(SubDeviceId subDeviceId, String recipeName) Get the list of child sub-device IDs for a value condition.
SubDeviceIdVector	getValueConditionParents(SubDeviceId subDeviceId, String recipeName) Get the list of parent sub-device IDs for a value condition.
SubDeviceIdVector	getValueConditionSiblings(SubDeviceId subDeviceId, String recipeName) Get the list of sibling sub-device IDs for a value condition.
SubDeviceIdVector	getCallConditionSubDeviceIdList(SubDeviceId subDeviceId, String recipeName) Get the list of sub-device IDs for a call condition.
StringVector	getCustomDriverAvailableDevices(String driverName) Get available devices for a custom driver.
void	addFunctionListener(FunctionListener listener) Add a function listener to the API.
void	addFunctionListener(FunctionListener listener, String deviceId) Add a function listener for a specific device.
void	addFunctionListener(FunctionListener listener, SubDeviceId subDeviceId) Add a function listener for a specific sub-device.
void	addFunctionListener(FunctionListener listener, SubDeviceId subDeviceId, EFunctionType functionType) Add a function listener for a specific sub-device and function type.
void	removeFunctionListener(FunctionListener listener) Remove a function listener from the API.
boolean	hasGetFunction(SubDeviceId subDeviceId) Check if a sub-device has a GET function.
boolean	hasSetFunction(SubDeviceId subDeviceId) Check if a sub-device has a SET function.
boolean	hasCheckFunction(SubDeviceId subDeviceId) Check if a sub-device has a CHECK function.
void	setValue(SubDeviceId subDeviceId) Call the SET function of the sub-device without parameters.
void	setValue(SubDeviceId subDeviceId, String value) Call the SET function of the sub-device with a string parameter.
void	setValue(SubDeviceId subDeviceId, char value) Call the SET function of the Sub Device with a char parameter.
void	setValue(SubDeviceId subDeviceId, short value) Call the SET function of the sub-device with a short parameter.
void	setValue(SubDeviceId subDeviceId, int value) Call the SET function of the sub-device with an int parameter.
void	setValue(SubDeviceId subDeviceId, java.math.BigInteger value) Call the SET function of the sub-device with an unsigned long long parameter.
void	setValue(SubDeviceId subDeviceId, long value) Call the SET function of the sub-device with a long long parameter.
void	setValue(SubDeviceId subDeviceId, float value) Call the SET function of the sub-device with a float parameter.
void	setValue(SubDeviceId subDeviceId, double value) Call the SET function of the sub-device with a double parameter.
String	getStringValue(SubDeviceId subDeviceId) Call the GET function of the sub-device returning a string.
char	getCharValue(SubDeviceId subDeviceId) Call the GET function of the sub-device returning a char.
short	getShortValue(SubDeviceId subDeviceId) Call the GET function of the sub-device returning a short.
int	getIntValue(SubDeviceId subDeviceId) Call the GET function of the sub-device returning an int.
java.math.BigInteger	getUnsignedLongValue(SubDeviceId subDeviceId) Call the GET function of the sub-device returning an unsigned long long.
long	getLongValue(SubDeviceId subDeviceId) Call the GET function of the sub-device returning a long long.
float	getFloatValue(SubDeviceId subDeviceId) Call the GET function of the sub-device returning a float.
double	getDoubleValue(SubDeviceId subDeviceId) Call the GET function of the sub-device returning a double.
StatusParam	getValue(StatusParam param) Get the value of a status parameter.
void	checkValue(SubDeviceId subDeviceId) Call the CHECK function of the sub-device without parameters.
void	checkValue(SubDeviceId subDeviceId, String value) Call the CHECK function of the sub-device with a string parameter.
void	checkValue(SubDeviceId subDeviceId, char value) Call the CHECK function of the sub-device with a char parameter.
void	checkValue(SubDeviceId subDeviceId, short value) Call the CHECK function of the sub-device with a short parameter.
void	checkValue(SubDeviceId subDeviceId, int value) Call the CHECK function of the sub-device with an int parameter.
void	checkValue(SubDeviceId subDeviceId, java.math.BigInteger value) Call the CHECK function of the sub-device with an unsigned long long parameter.
void	checkValue(SubDeviceId subDeviceId, long value) Call the CHECK function of the sub-device with a long long parameter.
void	checkValue(SubDeviceId subDeviceId, float value) Call the CHECK function of the sub-device with a float parameter.
void	checkValue(SubDeviceId subDeviceId, double value) Call the CHECK function of the sub-device with a double parameter.
SubDeviceIdVector	getModifiedSubDevices(String deviceId) Get the list of modified sub-devices for a loaded device.
boolean	isAccessibleInSequence(SubDeviceId subDeviceId) Check if the sub-device is accessible in sequence.
void	setClampMode(boolean clampMode) Set clamp mode.
boolean	hasMaxValue(SubDeviceId subDeviceId) Check if the sub-device has a max value constraint.
boolean	hasMinValue(SubDeviceId subDeviceId) Check if the sub-device has a min value constraint.
boolean	hasStepValue(SubDeviceId subDeviceId) Check if the sub-device has a step value constraint.
boolean	hasListValue(SubDeviceId subDeviceId) Check if the sub-device has a list value constraint.
boolean	isReadOnly(SubDeviceId subDeviceId) Check if the sub-device is read-only.
double	getMaxValue(SubDeviceId subDeviceId) Get the max value constraint of the sub-device.
double	getMinValue(SubDeviceId subDeviceId) Get the min value constraint of the sub-device.
double	getStepValue(SubDeviceId subDeviceId) Get the step value constraint of the sub-device.
StringVector	getListValue(SubDeviceId subDeviceId) Get the list of possible values (Deprecated).
StringStringMap	getKeyValueMap(SubDeviceId subDeviceId) Get the map of key-value pairs for list constraints.
EParamType	getParamType(SubDeviceId subDeviceId) Get the parameter type of the sub-device.
void	saveStatusListToXML(String xmlfilename, StatusVector statusList) Save a list of statuses to an XML file.
void	saveDimensionListToXML(String xmlfilename, DimensionVector dimensionList) Save a list of dimensions to an XML file.
Status	getCurrentStatus() Get the current status.
Status	getCurrentStatus(SubDeviceId subDeviceId) Get the current status for a specific sub-device.
Status	getCurrentStatus(SubDeviceIdVector subDeviceList) Get the current status for a list of sub-devices.
void	getCurrentStatus(CurrentStatusAction action) Get the current status through an action handler.
void	getCurrentStatus(SubDeviceId subDeviceId, CurrentStatusAction action) Get the current status for a specific sub-device through an action handler.
void	getCurrentStatus(SubDeviceIdVector subDeviceList, CurrentStatusAction action) Get the current status for a list of sub-devices through an action handler.
void	setCurrentStatus(Status status, boolean async) Set the current status.
void	setCurrentStatus(Status status) Set the current status.
StatusVector	getStatusList(DimensionVector dimensions) Convert a dimension list to a list of status.
void	addImageListener(ImageListener listener, String cameraId) Add an image listener.
void	addImageListener(ImageListener listener) Add an image listener.
void	removeImageListener(ImageListener listener, String cameraId) Remove an image listener.
void	removeImageListener(ImageListener listener) Remove an image listener.
void	removeImageListener(String cameraId) Remove an image listener by camera ID.
void	saveImages(String filename, ImageVector images) Save a list of images to a file.
ImageVector	loadImages(String filename) Load a list of images from a file.
String	getVersion() Get the current version of the API.
String	getFirmwareVersion() Get the Firmware version of the connected Inscoper Box if available.
void	initLogger(ELogMode mode, ELogLevel level, String filename, LogListener listener) Init the API logger.
void	initLogger(ELogMode mode, ELogLevel level, String filename) Init the API logger.
void	initLogger(ELogMode mode, ELogLevel level) Init the API logger.
void	setLogLevel(ELogLevel level) Set the log level.
void	removeLogListener(LogListener listener) Remove a log listener.
ELogLevel	getLogLevel() Get the log level of the application.
void	initInscoperBoxLogger(ELogMode mode, ELogLevel level, String filename, LogListener listener) Init the Inscoper Box logger.
void	initInscoperBoxLogger(ELogMode mode, ELogLevel level, String filename) Init the Inscoper Box logger.
void	initInscoperBoxLogger(ELogMode mode, ELogLevel level) Init the Inscoper Box logger.
void	setInscoperBoxLogLevel(ELogLevel level) Set the log level of the Inscoper Box.
void	removeInscoperBoxLogListener(LogListener listener) Remove an Inscoper Box log listener.
ELogLevel	getInscoperBoxLogLevel() Get the log level of the Inscoper Box firmware.
void	setLogDirectory(String path) Set the log directory path.
void	addErrorListener(ErrorListener listener) Add an error listener.
void	removeErrorListener(ErrorListener listener) Remove an error listener.
void	updateFirmware(String firmwarePath) Update the InscoperBox firmware.
boolean	connectToInscoperBox() Connect to the Inscoper Box.
boolean	disconnectToInscoperBox() Disconnect from the Inscoper Box.
boolean	isConnectedToInscoperBox() Check if connected to the Inscoper Box.
void	restartInscoperBox() Restart the Inscoper Box.
UsbInfoVector	getInscoperBoxUsbView() Get the USB view of the Inscoper Box.
void	resetInscoperBoxUsbView(double secondsToWaitBeforeReconnection) Reset the Inscoper Box USB view.
EBoxType	getInscoperBoxType() Get the type of the Inscoper Box.
boolean	checkLicense() Check if the license is valid.
void	setLicensePath(String path) Set the path to the license file.
boolean	hasLicenseOption(String option) Check if a specific license option is available.
boolean	hasLicenseExpirationDate() Check if the license has an expiration date.
long	getLicenseDaysLeft() Get the number of days left on the license.
SubDeviceId	getRunSequenceSubDeviceId() Get the "Run Sequence" sub-device ID.

Protected Functions¶

	Name
	Bridge(long cPtr, boolean cMemoryOwn)
void	finalize()
long	getCPtr(Bridge obj)
long	swigRelease(Bridge obj)

Protected Attributes¶

	Name
transient boolean	swigCMemOwn

Detailed Description¶

public class com.inscoper.api.Bridge;

The Bridge class is the main class of The Inscoper API.

It is the entry point for most applications.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function getValue¶

public Object getValue(
    SubDeviceId subDeviceId
)

function Bridge¶

public Bridge()

Default constructor.

Constructs the Bridge object.

function setLibraryPaths¶

public void setLibraryPaths(
    StringVector libraryPaths
)

Set the library paths where to find external libraries (MicroManager, Custom driver etc).

Parameters:

libraryPaths : The list of library paths

Sets the paths to search for external libraries.

function loadConfigFile¶

public void loadConfigFile(
    String path
)

Load configuration based on its file path.

Parameters:

path : The directory path where the file config.xml is located

Exceptions:

InscoperException if an error occurred

Loads the configuration from the specified file path.

function loadConfigFile¶

public void loadConfigFile()

Load configuration based on its file path.

Exceptions:

InscoperException if an error occurred

Loads the configuration from the specified file path.

function readConfigFile¶

public Config readConfigFile(
    String path
)

Read the configuration file and return the corresponding configuration.

Parameters:

path : The directory path where the file config.xml is located

Exceptions:

InscoperException if an error occurred

Return: The configuration

Reads and parses the configuration file.

function readConfigFile¶

public Config readConfigFile()

Read the configuration file and return the corresponding configuration.

Exceptions:

InscoperException if an error occurred

Return: The configuration

Reads and parses the configuration file.

function loadConfig¶

public void loadConfig(
    Config config
)

Load the configuration.

Parameters:

config : The configuration

Exceptions:

InscoperException if an error occurred

Loads the provided configuration.

function saveConfig¶

public void saveConfig(
    String path,
    Config config
)

Save the configuration to an XML file.

Parameters:

path : The path where, to save the configuration. The path could be either the directory path of XML file (in this case, the XML file name will be 'config.xml') or the XML file itself
config : The configuration to save

Exceptions:

InscoperException if an error occurred

Saves the provided configuration to the specified path.

function saveCurrentConfig¶

public void saveCurrentConfig(
    String path
)

Save the current loaded configuration to an XML file.

Parameters:

path : The path where, to save the configuration. The path could be either the directory path of XML file (in this case, the XML file name will be 'config.xml') or the XML file itself

Exceptions:

InscoperException if an error occurred

Saves the currently loaded configuration to the specified path.

function saveCurrentConfig¶

public void saveCurrentConfig()

Save the current loaded configuration to an XML file.

Exceptions:

InscoperException if an error occurred

Saves the currently loaded configuration to the specified path.

function readRecipeFile¶

public RecipeVector readRecipeFile(
    String path
)

Read the recipe file and return the list of corresponding recipes.

Parameters:

path : The directory path where the file recipe.xml is located

Exceptions:

InscoperException if an error occurred

Return: The list of the recipes

Parses the recipe XML file and creates a list of recipes.

function readRecipeFile¶

public RecipeVector readRecipeFile()

Read the recipe file and return the list of corresponding recipes.

Exceptions:

InscoperException if an error occurred

Return: The list of the recipes

Parses the recipe XML file and creates a list of recipes.

function saveRecipes¶

public void saveRecipes(
    String path,
    RecipeVector recipes
)

Save the list of recipes to an XML file.

Parameters:

path : The path where, to save the recipes. The path could be either the directory path of XML file (in this case, the XML file name will be 'recipe.xml') or the XML file itself
recipes : The list of the recipes

Exceptions:

InscoperException if an error occurred

Serializes the provided list of recipes to the specified file.

function initDevices¶

public void initDevices()

Initialize all the loaded devices.

Exceptions:

InscoperException if an error occurred

Iterates through all loaded devices and initializes them sequentially.

function initDevice¶

public void initDevice(
    String deviceId
)

Initialize a specific device.

Parameters:

deviceId : The ID of the device to initialize

Exceptions:

InscoperException if an error occurred

Initializes the device with the specified ID.

function initDevices¶

public void initDevices(
    StringVector deviceIdList
)

Initialize a list of devices.

Parameters:

deviceIdList : The list of device IDs to initialize

Exceptions:

InscoperException if an error occurred

Initializes the devices specified in the list sequentially.

function getLoadedDevices¶

public StringVector getLoadedDevices()

Get the list of IDs of all loaded devices.

Return: The list of device ID strings

Retrieves the IDs of devices that are currently loaded into memory.

function getInitializedDevices¶

public StringVector getInitializedDevices()

Get the list of IDs of all initialized devices.

Return: The list of device ID strings

Retrieves the IDs of devices that have been successfully initialized.

function getInitializedSubDeviceIds¶

public SubDeviceIdVector getInitializedSubDeviceIds()

Get the list of sub-device IDs for all initialized sub-devices.

Return: The list of sub-device IDs

Retrieves the sub-device IDs for every initialized sub-device component.

function closeDevices¶

public boolean closeDevices()

Close all the loaded devices.

Exceptions:

InscoperException if an error occurred

Return: True if successful, false otherwise

Shuts down all loaded devices.

function closeDevice¶

public boolean closeDevice(
    String deviceId
)

Close a specific device.

Parameters:

deviceId : The ID of the device to close

Return: True if successful, false otherwise

Shuts down the device with the specified ID.

function closeDevices¶

public boolean closeDevices(
    StringVector deviceIdList
)

Close a list of devices.

Parameters:

deviceIdList : The list of device IDs to close

Return: True if successful, false otherwise

Shuts down the devices specified in the list.

function close¶

public void close()

Close all the initialized devices, loaded drivers and more.

Exceptions:

InscoperException if an error occurred

Performs a complete shutdown of the system, including drivers and initialized devices.

function getDeviceDescriptionList¶

public DeviceDescriptionVector getDeviceDescriptionList()

Get the device description list of all the available drivers (Inscoper Box, Micro Manager and Custom drivers).

Exceptions:

InscoperException if an error occurred

Return: The list of device descriptions

Retrieves the descriptions for all drivers currently available in the system.

function loadDeviceDescriptionList¶

public DeviceDescriptionVector loadDeviceDescriptionList(
    String filename
)

Load the device description list from a file.

Parameters:

filename : The path to the file containing device descriptions

Exceptions:

InscoperException if an error occurred

Return: The list of device descriptions

Parses the specified file to load device descriptions.

function saveDeviceDescriptionList¶

public void saveDeviceDescriptionList(
    DeviceDescriptionVector deviceDescriptionList,
    String filename
)

Save the device description list to a file.

Parameters:

deviceDescriptionList : The list of device descriptions to save
filename : The destination file path

Exceptions:

InscoperException if an error occurred

Serializes the provided list of device descriptions to the specified file.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    String paramsFile,
    Status currentStatus,
    int printIndex,
    SequenceHandler handler
)

Load a sequence with user params.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
paramsFile : The name of the file containing user params. The file can be either a StatusList file or a Dimensions file
currentStatus : The current status of the microscope (optional)
printIndex : The index for printing (default -1)
handler : The sequence handler (optional)

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided user parameters file.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    String paramsFile,
    Status currentStatus,
    int printIndex
)

Load a sequence with user params.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
paramsFile : The name of the file containing user params. The file can be either a StatusList file or a Dimensions file
currentStatus : The current status of the microscope (optional)
printIndex : The index for printing (default -1)

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided user parameters file.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    String paramsFile,
    Status currentStatus
)

Load a sequence with user params.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
paramsFile : The name of the file containing user params. The file can be either a StatusList file or a Dimensions file
currentStatus : The current status of the microscope (optional)

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided user parameters file.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    String paramsFile
)

Load a sequence with user params.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
paramsFile : The name of the file containing user params. The file can be either a StatusList file or a Dimensions file

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided user parameters file.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    DimensionVector dimensionList,
    Status currentStatus,
    int printIndex,
    SequenceHandler handler
)

Load a sequence with dimensions.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
dimensionList : The list of dimensions
currentStatus : The current status of the microscope (optional)
printIndex : The index for printing (default -1)
handler : The sequence handler (optional)

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided list of dimensions.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    DimensionVector dimensionList,
    Status currentStatus,
    int printIndex
)

Load a sequence with dimensions.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
dimensionList : The list of dimensions
currentStatus : The current status of the microscope (optional)
printIndex : The index for printing (default -1)

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided list of dimensions.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    DimensionVector dimensionList,
    Status currentStatus
)

Load a sequence with dimensions.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
dimensionList : The list of dimensions
currentStatus : The current status of the microscope (optional)

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided list of dimensions.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    DimensionVector dimensionList
)

Load a sequence with dimensions.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
dimensionList : The list of dimensions

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided list of dimensions.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    StatusVector statusList,
    Status currentStatus,
    int printIndex,
    SequenceHandler handler
)

Load a sequence with status list.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
statusList : The list of status
currentStatus : The current status of the microscope (optional)
printIndex : The index for printing (default -1)
handler : The sequence handler (optional)

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided list of statuses.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    StatusVector statusList,
    Status currentStatus,
    int printIndex
)

Load a sequence with status list.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
statusList : The list of status
currentStatus : The current status of the microscope (optional)
printIndex : The index for printing (default -1)

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided list of statuses.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    StatusVector statusList,
    Status currentStatus
)

Load a sequence with status list.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
statusList : The list of status
currentStatus : The current status of the microscope (optional)

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided list of statuses.

function loadSequence¶

public Status loadSequence(
    int sequenceNumber,
    String recipeName,
    StatusVector statusList
)

Load a sequence with status list.

Parameters:

sequenceNumber : The sequence number
recipeName : The recipe name described in the recipe.xml file
statusList : The list of status

Exceptions:

InscoperException if an error occurred

Return: The sequence status

Loads a sequence using the provided list of statuses.

function runSequence¶

public void runSequence(
    int sequenceNumber,
    boolean async
)

Run a preloaded sequence.

Parameters:

sequenceNumber : The sequence number to run
async : True if you want the function to be asynchronous. You will need to call waitUntilSequenceFinished later to know when the sequence is finished

Exceptions:

InscoperException if an error occurred

Executes the sequence identified by the sequence number.

function runSequence¶

public void runSequence(
    int sequenceNumber
)

Run a preloaded sequence.

Parameters:

sequenceNumber : The sequence number to run

Exceptions:

InscoperException if an error occurred

Executes the sequence identified by the sequence number.

function waitUntilSequenceFinished¶

public void waitUntilSequenceFinished(
    int sequenceNumber
)

Wait for the sequence to finish.

Parameters:

sequenceNumber : The sequence number

Exceptions:

InscoperException if an error occurred

Blocks execution until the specified sequence has completed.

function pauseSequence¶

public void pauseSequence(
    int sequenceNumber
)

Pause the running sequence.

Parameters:

sequenceNumber : The sequence number

Exceptions:

InscoperException if an error occurred

Pauses the execution of the specified sequence.

function continueSequence¶

public void continueSequence(
    int sequenceNumber
)

Continue the paused sequence.

Parameters:

sequenceNumber : The sequence number

Exceptions:

InscoperException if an error occurred

Resumes the execution of the specified sequence.

function stopSequence¶

public void stopSequence(
    int sequenceNumber
)

Stop the running sequence.

Parameters:

sequenceNumber : The sequence number

Exceptions:

InscoperException if an error occurred

Stops the execution of the specified sequence.

function removeSequence¶

public void removeSequence(
    int sequenceNumber
)

Remove the loaded sequence.

Parameters:

sequenceNumber : The sequence number

Exceptions:

InscoperException if an error occurred

Unloads and removes the specified sequence from memory.

function modifySequence¶

public void modifySequence(
    int sequenceNumber,
    UIntVector modifierIndexes
)

Modify the loaded sequence.

Parameters:

sequenceNumber : The sequence number
modifierIndexes : The list of param to modify

Exceptions:

InscoperException if an error occurred

Modifies the sequence using the specified modifier indexes.

function addBackgroundSequence¶

public Status addBackgroundSequence(
    int sequenceIndex,
    String recipeName,
    String paramsFile
)

Add a background sequence with params file.

Parameters:

sequenceIndex : The sequence number (or index)
recipeName : The name of the recipe
paramsFile : The path to the file containing parameters

Exceptions:

InscoperException if an error occurred

Return: The status of the newly added sequence

Adds a background sequence using a parameters file.

function addBackgroundSequence¶

public Status addBackgroundSequence(
    int sequenceIndex,
    String recipeName,
    DimensionVector dimensionList
)

Add a background sequence with dimension list.

Parameters:

sequenceIndex : The sequence number (or index)
recipeName : The name of the recipe
dimensionList : The list of dimensions for the sequence

Exceptions:

InscoperException if an error occurred

Return: The status of the newly added sequence

Adds a background sequence using a list of dimensions.

function addBackgroundSequence¶

public Status addBackgroundSequence(
    int sequenceIndex,
    String recipeName,
    StatusVector statusList
)

Add a background sequence with status list.

Parameters:

sequenceIndex : The sequence number (or index)
recipeName : The name of the recipe
statusList : The list of statuses for the sequence

Exceptions:

InscoperException if an error occurred

Return: The status of the newly added sequence

Adds a background sequence using a list of statuses.

function removeBackgroundSequence¶

public void removeBackgroundSequence(
    int sequenceIndex
)

Remove a background sequence.

Parameters:

sequenceIndex : The sequence number (or index)

Exceptions:

InscoperException if an error occurred

Removes the specified background sequence.

function addSequenceListener¶

public void addSequenceListener(
    SequenceListener listener
)

Add a sequence listener to the API.

Parameters:

listener : The listener to add

Registers a listener for sequence events.

function removeSequenceListener¶

public void removeSequenceListener(
    SequenceListener listener
)

Remove a sequence listener from the API.

Parameters:

listener : The listener to remove

Unregisters a previously added sequence listener.

function addAbstractSubDevice¶

public void addAbstractSubDevice(
    AbstractSubDevice subDevice
)

Add an abstract sub device.

Parameters:

subDevice : The abstract sub-device to add

Exceptions:

InscoperException if an error occurred

Adds an abstract sub-device to the system.

function removeAbstractSubDevice¶

public void removeAbstractSubDevice(
    SubDeviceId subDeviceId
)

Remove an abstract sub device.

Parameters:

subDeviceId : The ID of the sub device to remove

Exceptions:

InscoperException if an error occurred

Removes an abstract sub-device from the system.

function getCamera¶

public Camera getCamera(
    String id
)

Get a camera device.

Parameters:

id : The camera ID

Exceptions:

InscoperException if an error occurred

Return: The camera

Retrieves the camera device with the specified ID.

function isHardwareCropAvailable¶

public boolean isHardwareCropAvailable(
    String id
)

Check if hardware crop is available for a camera.

Parameters:

id : The camera ID

Exceptions:

InscoperException if an error occurred

Return: True if hardware crop is available, false otherwise

Determines if the specified camera supports hardware cropping.

function setHardwareCrop¶

public void setHardwareCrop(
    String id,
    RoiCropVector crops
)

Set hardware crop for a camera.

Parameters:

id : The camera ID
crops : The list of crop regions (ROIs)

Exceptions:

InscoperException if an error occurred

Configures the hardware crop settings for the specified camera.

function getHardwareCrop¶

public RoiCropVector getHardwareCrop(
    String id
)

Get the current hardware crop configuration for a camera.

Parameters:

id : The camera ID

Exceptions:

InscoperException if an error occurred

Return: The list of current crop regions (ROIs)

Retrieves the current hardware crop settings for the specified camera.

function createTimeDevice¶

public void createTimeDevice(
    int index,
    String startRecipeId,
    String waitRecipeId
)

Create a time device.

Parameters:

index : The index of the time device
startRecipeId : The ID of the start recipe (optional)
waitRecipeId : The ID of the wait recipe (optional)

Exceptions:

InscoperException if an error occurred

Creates a new time device with the specified index.

function createTimeDevice¶

public void createTimeDevice(
    int index,
    String startRecipeId
)

Create a time device.

Parameters:

index : The index of the time device
startRecipeId : The ID of the start recipe (optional)

Exceptions:

InscoperException if an error occurred

Creates a new time device with the specified index.

function createTimeDevice¶

public void createTimeDevice(
    int index
)

Create a time device.

Parameters:

index : The index of the time device

Exceptions:

InscoperException if an error occurred

Creates a new time device with the specified index.

function getStartTimerSubDeviceId¶

public SubDeviceId getStartTimerSubDeviceId(
    int index
)

Get the sub-device ID for the start timer.

Parameters:

index : The index of the timer

Exceptions:

InscoperException if an error occurred

Return: The sub-device ID of the start timer

Retrieves the sub-device ID associated with the start timer.

function getWaitTimerSubDeviceId¶

public SubDeviceId getWaitTimerSubDeviceId(
    int index
)

Get the sub-device ID for the wait timer.

Parameters:

index : The index of the timer

Exceptions:

InscoperException if an error occurred

Return: The sub-device ID of the wait timer

Retrieves the sub-device ID associated with the wait timer.

function runDeviceDiagnosis¶

public DiagResults runDeviceDiagnosis(
    DeviceDescription deviceDesc,
    DriverConfig driverConfig
)

Run diagnosis on a device.

Parameters:

deviceDesc : The device description
driverConfig : The driver configuration

Exceptions:

InscoperException if an error occurred

Return: The diagnosis results

Executes a diagnosis sequence on the specified device.

function saveDiagResults¶

public void saveDiagResults(
    DiagResults diagResults,
    String filename
)

Save diagnosis results to a file.

Parameters:

diagResults : The diagnosis results to save
filename : The file path to save to

Saves the provided diagnosis results to the specified file.

function loadDiagResults¶

public DiagResults loadDiagResults(
    String filename
)

Load diagnosis results from a file.

Parameters:

filename : The file path to load from

Return: The loaded diagnosis results

Loads diagnosis results from the specified file.

function saveDiagResultsList¶

public void saveDiagResultsList(
    DiagResultsVector diagResultsList,
    String filename
)

Save a list of diagnosis results to a file.

Parameters:

diagResultsList : The list of diagnosis results
filename : The file path to save to

Saves the provided list of diagnosis results to the specified file.

function loadDiagResultsList¶

public DiagResultsVector loadDiagResultsList(
    String filename
)

Load a list of diagnosis results from a file.

Parameters:

filename : The file path to load from

Return: The list of loaded diagnosis results

Loads a list of diagnosis results from the specified file.

function getValueConditionChildren¶

public SubDeviceIdVector getValueConditionChildren(
    SubDeviceId subDeviceId,
    String recipeName
)

Get the list of child sub-device IDs for a value condition.

Parameters:

subDeviceId : The parent sub-device ID
recipeName : The recipe name

Exceptions:

InscoperException if an error occurred

Return: The list of child sub-device IDs

Retrieves the child sub-device IDs associated with a value condition.

function getValueConditionParents¶

public SubDeviceIdVector getValueConditionParents(
    SubDeviceId subDeviceId,
    String recipeName
)

Get the list of parent sub-device IDs for a value condition.

Parameters:

subDeviceId : The child sub-device ID
recipeName : The recipe name

Exceptions:

InscoperException if an error occurred

Return: The list of parent sub-device IDs

Retrieves the parent sub-device IDs associated with a value condition.

function getValueConditionSiblings¶

public SubDeviceIdVector getValueConditionSiblings(
    SubDeviceId subDeviceId,
    String recipeName
)

Get the list of sibling sub-device IDs for a value condition.

Parameters:

subDeviceId : The sub-device ID
recipeName : The recipe name

Exceptions:

InscoperException if an error occurred

Return: The list of sibling sub-device IDs

Retrieves the sibling sub-device IDs associated with a value condition.

function getCallConditionSubDeviceIdList¶

public SubDeviceIdVector getCallConditionSubDeviceIdList(
    SubDeviceId subDeviceId,
    String recipeName
)

Get the list of sub-device IDs for a call condition.

Parameters:

subDeviceId : The sub-device ID
recipeName : The recipe name

Exceptions:

InscoperException if an error occurred

Return: The list of sub-device IDs involved in the call condition

Retrieves the sub-device IDs associated with a call condition.

function getCustomDriverAvailableDevices¶

public StringVector getCustomDriverAvailableDevices(
    String driverName
)

Get available devices for a custom driver.

Parameters:

driverName : The name of the custom driver

Exceptions:

InscoperException if an error occurred

Return: The list of available device names

Retrieves the list of available devices for the specified custom driver.

function addFunctionListener¶

public void addFunctionListener(
    FunctionListener listener
)

Add a function listener to the API.

Parameters:

listener : The listener to add

Registers a listener for function events.

function addFunctionListener¶

public void addFunctionListener(
    FunctionListener listener,
    String deviceId
)

Add a function listener for a specific device.

Parameters:

listener : The listener to add
deviceId : The device ID to listen to

Registers a listener for function events on a specific device.

function addFunctionListener¶

public void addFunctionListener(
    FunctionListener listener,
    SubDeviceId subDeviceId
)

Add a function listener for a specific sub-device.

Parameters:

listener : The listener to add
subDeviceId : The sub-device ID to listen to

Registers a listener for function events on a specific sub-device.

function addFunctionListener¶

public void addFunctionListener(
    FunctionListener listener,
    SubDeviceId subDeviceId,
    EFunctionType functionType
)

Add a function listener for a specific sub-device and function type.

Parameters:

listener : The listener to add
subDeviceId : The sub-device ID to listen to
functionType : The type of function to listen to

Registers a listener for specific function types on a sub-device.

function removeFunctionListener¶

public void removeFunctionListener(
    FunctionListener listener
)

Remove a function listener from the API.

Parameters:

listener : The listener to remove

Unregisters a previously added function listener.

function hasGetFunction¶

public boolean hasGetFunction(
    SubDeviceId subDeviceId
)

Check if a sub-device has a GET function.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: True if it has a GET function, false otherwise

Determines if the sub-device supports the GET operation.

function hasSetFunction¶

public boolean hasSetFunction(
    SubDeviceId subDeviceId
)

Check if a sub-device has a SET function.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: True if it has a SET function, false otherwise

Determines if the sub-device supports the SET operation.

function hasCheckFunction¶

public boolean hasCheckFunction(
    SubDeviceId subDeviceId
)

Check if a sub-device has a CHECK function.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: True if it has a CHECK function, false otherwise

Determines if the sub-device supports the CHECK operation.

function setValue¶

public void setValue(
    SubDeviceId subDeviceId
)

Call the SET function of the sub-device without parameters.

Parameters:

subDeviceId : The sub-device ID of the sub-device

Exceptions:

InscoperException if an error occurred

Executes the SET command on the sub-device with no arguments.

function setValue¶

public void setValue(
    SubDeviceId subDeviceId,
    String value
)

Call the SET function of the sub-device with a string parameter.

Parameters:

subDeviceId : The sub-device ID of the sub-device
value : The string representation of the value

Exceptions:

InscoperException if an error occurred

Executes the SET command on the sub-device with a string value.

function setValue¶

public void setValue(
    SubDeviceId subDeviceId,
    char value
)

Call the SET function of the Sub Device with a char parameter.

Parameters:

subDeviceId : The sub-device ID of the sub-device
value : The char value

Exceptions:

InscoperException if an error occurred

Executes the SET command on the sub-device with a char value.

function setValue¶

public void setValue(
    SubDeviceId subDeviceId,
    short value
)

Call the SET function of the sub-device with a short parameter.

Parameters:

subDeviceId : The sub-device ID of the sub-device
value : The short value

Exceptions:

InscoperException if an error occurred

Executes the SET command on the sub-device with a short value.

function setValue¶

public void setValue(
    SubDeviceId subDeviceId,
    int value
)

Call the SET function of the sub-device with an int parameter.

Parameters:

subDeviceId : The sub-device ID
value : The int value

Exceptions:

InscoperException if an error occurred

Executes the SET command on the sub-device with an int value.

function setValue¶

public void setValue(
    SubDeviceId subDeviceId,
    java.math.BigInteger value
)

Call the SET function of the sub-device with an unsigned long long parameter.

Parameters:

subDeviceId : The sub-device ID of the sub-device
value : The unsigned long long int value

Exceptions:

InscoperException if an error occurred

Executes the SET command on the sub-device with an unsigned long long value.

function setValue¶

public void setValue(
    SubDeviceId subDeviceId,
    long value
)

Call the SET function of the sub-device with a long long parameter.

Parameters:

subDeviceId : The sub-device ID
value : The long long int value

Exceptions:

InscoperException if an error occurred

Executes the SET command on the sub-device with a long long value.

function setValue¶

public void setValue(
    SubDeviceId subDeviceId,
    float value
)

Call the SET function of the sub-device with a float parameter.

Parameters:

subDeviceId : The sub-device ID
value : The float value

Exceptions:

InscoperException if an error occurred

Executes the SET command on the sub-device with a float value.

function setValue¶

public void setValue(
    SubDeviceId subDeviceId,
    double value
)

Call the SET function of the sub-device with a double parameter.

Parameters:

subDeviceId : The sub-device ID
value : The double value

Exceptions:

InscoperException if an error occurred

Executes the SET command on the sub-device with a double value.

function getStringValue¶

public String getStringValue(
    SubDeviceId subDeviceId
)

Call the GET function of the sub-device returning a string.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The standard string value

Executes the GET command on the sub-device and returns a string.

function getCharValue¶

public char getCharValue(
    SubDeviceId subDeviceId
)

Call the GET function of the sub-device returning a char.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The char value

Executes the GET command on the sub-device and returns a char.

function getShortValue¶

public short getShortValue(
    SubDeviceId subDeviceId
)

Call the GET function of the sub-device returning a short.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The short value

Executes the GET command on the sub-device and returns a short.

function getIntValue¶

public int getIntValue(
    SubDeviceId subDeviceId
)

Call the GET function of the sub-device returning an int.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The int value

Executes the GET command on the sub-device and returns an int.

function getUnsignedLongValue¶

public java.math.BigInteger getUnsignedLongValue(
    SubDeviceId subDeviceId
)

Call the GET function of the sub-device returning an unsigned long long.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The unsigned long long int value

Executes the GET command on the sub-device and returns an unsigned long long.

function getLongValue¶

public long getLongValue(
    SubDeviceId subDeviceId
)

Call the GET function of the sub-device returning a long long.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The long long int value

Executes the GET command on the sub-device and returns a long long.

function getFloatValue¶

public float getFloatValue(
    SubDeviceId subDeviceId
)

Call the GET function of the sub-device returning a float.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The float value

Executes the GET command on the sub-device and returns a float.

function getDoubleValue¶

public double getDoubleValue(
    SubDeviceId subDeviceId
)

Call the GET function of the sub-device returning a double.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The double value

Executes the GET command on the sub-device and returns a double.

function getValue¶

public StatusParam getValue(
    StatusParam param
)

Get the value of a status parameter.

Parameters:

param : The status parameter to get the value from

Exceptions:

InscoperException if an error occurred

Return: The updated status parameter

Retrieves the value from the specified status parameter.

function checkValue¶

public void checkValue(
    SubDeviceId subDeviceId
)

Call the CHECK function of the sub-device without parameters.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Executes the CHECK command on the sub-device with no arguments.

function checkValue¶

public void checkValue(
    SubDeviceId subDeviceId,
    String value
)

Call the CHECK function of the sub-device with a string parameter.

Parameters:

subDeviceId : The sub-device ID
value : The string representation of the value

Exceptions:

InscoperException if an error occurred

Executes the CHECK command on the sub-device with a string value.

function checkValue¶

public void checkValue(
    SubDeviceId subDeviceId,
    char value
)

Call the CHECK function of the sub-device with a char parameter.

Parameters:

subDeviceId : The sub-device ID
value : The char value

Exceptions:

InscoperException if an error occurred

Executes the CHECK command on the sub-device with a char value.

function checkValue¶

public void checkValue(
    SubDeviceId subDeviceId,
    short value
)

Call the CHECK function of the sub-device with a short parameter.

Parameters:

subDeviceId : The sub-device ID
value : The short value

Exceptions:

InscoperException if an error occurred

Executes the CHECK command on the sub-device with a short value.

function checkValue¶

public void checkValue(
    SubDeviceId subDeviceId,
    int value
)

Call the CHECK function of the sub-device with an int parameter.

Parameters:

subDeviceId : The sub-device ID
value : The int value

Exceptions:

InscoperException if an error occurred

Executes the CHECK command on the sub-device with an int value.

function checkValue¶

public void checkValue(
    SubDeviceId subDeviceId,
    java.math.BigInteger value
)

Call the CHECK function of the sub-device with an unsigned long long parameter.

Parameters:

subDeviceId : The sub-device ID
value : The unsigned long long int value

Exceptions:

InscoperException if an error occurred

Executes the CHECK command on the sub-device with an unsigned long long value.

function checkValue¶

public void checkValue(
    SubDeviceId subDeviceId,
    long value
)

Call the CHECK function of the sub-device with a long long parameter.

Parameters:

subDeviceId : The sub-device ID
value : The long long int value

Exceptions:

InscoperException if an error occurred

Executes the CHECK command on the sub-device with a long long value.

function checkValue¶

public void checkValue(
    SubDeviceId subDeviceId,
    float value
)

Call the CHECK function of the sub-device with a float parameter.

Parameters:

subDeviceId : The sub-device ID
value : The float value

Exceptions:

InscoperException if an error occurred

Executes the CHECK command on the sub-device with a float value.

function checkValue¶

public void checkValue(
    SubDeviceId subDeviceId,
    double value
)

Call the CHECK function of the sub-device with a double parameter.

Parameters:

subDeviceId : The sub-device ID
value : The double value

Exceptions:

InscoperException if an error occurred

Executes the CHECK command on the sub-device with a double value.

function getModifiedSubDevices¶

public SubDeviceIdVector getModifiedSubDevices(
    String deviceId
)

Get the list of modified sub-devices for a loaded device.

Parameters:

deviceId : The device ID

Return: The list of modified sub-device IDs

Retrieves the list of sub-device IDs that have been modified for the specified device.

function isAccessibleInSequence¶

public boolean isAccessibleInSequence(
    SubDeviceId subDeviceId
)

Check if the sub-device is accessible in sequence.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: True if accessible, false otherwise

Determines if the sub-device can be accessed within a sequence.

function setClampMode¶

public void setClampMode(
    boolean clampMode
)

Set clamp mode.

Parameters:

clampMode : True to enable clamp mode, false otherwise

Enables or disables clamp mode.

function hasMaxValue¶

public boolean hasMaxValue(
    SubDeviceId subDeviceId
)

Check if the sub-device has a max value constraint.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: True if it has a max value, false otherwise

Determines if the sub-device has a maximum value limit.

function hasMinValue¶

public boolean hasMinValue(
    SubDeviceId subDeviceId
)

Check if the sub-device has a min value constraint.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: True if it has a min value, false otherwise

Determines if the sub-device has a minimum value limit.

function hasStepValue¶

public boolean hasStepValue(
    SubDeviceId subDeviceId
)

Check if the sub-device has a step value constraint.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: True if it has a step value, false otherwise

Determines if the sub-device has a step value constraint.

function hasListValue¶

public boolean hasListValue(
    SubDeviceId subDeviceId
)

Check if the sub-device has a list value constraint.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: True if it has a list value, false otherwise

Determines if the sub-device has a restricted list of values.

function isReadOnly¶

public boolean isReadOnly(
    SubDeviceId subDeviceId
)

Check if the sub-device is read-only.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: True if read-only, false otherwise

Determines if the sub-device is read-only.

function getMaxValue¶

public double getMaxValue(
    SubDeviceId subDeviceId
)

Get the max value constraint of the sub-device.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The maximum value

Retrieves the maximum allowed value for the sub-device.

function getMinValue¶

public double getMinValue(
    SubDeviceId subDeviceId
)

Get the min value constraint of the sub-device.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The minimum value

Retrieves the minimum allowed value for the sub-device.

function getStepValue¶

public double getStepValue(
    SubDeviceId subDeviceId
)

Get the step value constraint of the sub-device.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The step value

Retrieves the step value constraint for the sub-device.

function getListValue¶

public StringVector getListValue(
    SubDeviceId subDeviceId
)

Get the list of possible values (Deprecated).

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The list of value strings

Retrieves the list of allowed values for the sub-device (deprecated).

function getKeyValueMap¶

public StringStringMap getKeyValueMap(
    SubDeviceId subDeviceId
)

Get the map of key-value pairs for list constraints.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The map of key-value pairs

Retrieves the map of allowed key-value pairs for the sub-device.

function getParamType¶

public EParamType getParamType(
    SubDeviceId subDeviceId
)

Get the parameter type of the sub-device.

Parameters:

subDeviceId : The sub-device ID

Exceptions:

InscoperException if an error occurred

Return: The parameter type

Retrieves the parameter type of the sub-device.

function saveStatusListToXML¶

public void saveStatusListToXML(
    String xmlfilename,
    StatusVector statusList
)

Save a list of statuses to an XML file.

Parameters:

xmlfilename : The path of the xml file
statusList : The status list to save

Exceptions:

InscoperException if an error occurred

Serializes the provided list of statuses to the specified XML file.

function saveDimensionListToXML¶

public void saveDimensionListToXML(
    String xmlfilename,
    DimensionVector dimensionList
)

Save a list of dimensions to an XML file.

Parameters:

xmlfilename : The path of the xml file
dimensionList : The dimension list to save

Exceptions:

InscoperException if an error occurred

Serializes the provided list of dimensions to the specified XML file.

function getCurrentStatus¶

public Status getCurrentStatus()

Get the current status.

Exceptions:

InscoperException if an error occurred

Return: The current status

Retrieves the current status of the microscope.

function getCurrentStatus¶

public Status getCurrentStatus(
    SubDeviceId subDeviceId
)

Get the current status for a specific sub-device.

Parameters:

subDeviceId : The sub-device ID to get status for

Exceptions:

InscoperException if an error occurred

Return: The current status containing only the specified sub-device

Retrieves the current status of the specified sub-device.

function getCurrentStatus¶

public Status getCurrentStatus(
    SubDeviceIdVector subDeviceList
)

Get the current status for a list of sub-devices.

Parameters:

subDeviceList : The list of sub-devices to get status for

Exceptions:

InscoperException if an error occurred

Return: The current status containing the specified sub-devices

Retrieves the current status of the specified list of sub-devices.

function getCurrentStatus¶

public void getCurrentStatus(
    CurrentStatusAction action
)

Get the current status through an action handler.

Parameters:

action : The action handler to receive the status parameters

Exceptions:

InscoperException if an error occurred

Retrieves the current status using an action handler.

function getCurrentStatus¶

public void getCurrentStatus(
    SubDeviceId subDeviceId,
    CurrentStatusAction action
)

Get the current status for a specific sub-device through an action handler.

Parameters:

subDeviceId : The sub-device ID
action : The action handler

Exceptions:

InscoperException if an error occurred

Retrieves the current status of a sub-device using an action handler.

function getCurrentStatus¶

public void getCurrentStatus(
    SubDeviceIdVector subDeviceList,
    CurrentStatusAction action
)

Get the current status for a list of sub-devices through an action handler.

Parameters:

subDeviceList : The list of sub-devices
action : The action handler

Exceptions:

InscoperException if an error occurred

Retrieves the current status of a list of sub-devices using an action handler.

function setCurrentStatus¶

public void setCurrentStatus(
    Status status,
    boolean async
)

Set the current status.

Parameters:

status : The status to set
async : If true, set status asynchronously (default false)

Exceptions:

InscoperException if an error occurred

Sets the status of the microscope.

function setCurrentStatus¶

public void setCurrentStatus(
    Status status
)

Set the current status.

Parameters:

status : The status to set

Exceptions:

InscoperException if an error occurred

Sets the status of the microscope.

function getStatusList¶

public StatusVector getStatusList(
    DimensionVector dimensions
)

Convert a dimension list to a list of status.

Parameters:

dimensions : The dimension list to convert

Return: The converted status list

Converts a list of dimensions into a list of statuses.

function addImageListener¶

public void addImageListener(
    ImageListener listener,
    String cameraId
)

Add an image listener.

Parameters:

listener : The listener to add
cameraId : The camera ID linked to the listener. If null, all cameras are linked

Registers a listener for image events.

function addImageListener¶

public void addImageListener(
    ImageListener listener
)

Add an image listener.

Parameters:

listener : The listener to add

Registers a listener for image events.

function removeImageListener¶

public void removeImageListener(
    ImageListener listener,
    String cameraId
)

Remove an image listener.

Parameters:

listener : The listener to remove
cameraId : The camera ID (optional)

Unregisters a previously added image listener.

function removeImageListener¶

public void removeImageListener(
    ImageListener listener
)

Remove an image listener.

Parameters:

listener : The listener to remove

Unregisters a previously added image listener.

function removeImageListener¶

public void removeImageListener(
    String cameraId
)

Remove an image listener by camera ID.

Parameters:

cameraId : The camera ID

Unregisters all image listeners associated with the specified camera ID.

function saveImages¶

public void saveImages(
    String filename,
    ImageVector images
)

Save a list of images to a file.

Parameters:

filename : The destination file path
images : The list of images to save

Exceptions:

InscoperException if an error occurred

Saves the provided list of images to the specified file.

function loadImages¶

public ImageVector loadImages(
    String filename
)

Load a list of images from a file.

Parameters:

filename : The source file path

Exceptions:

InscoperException if an error occurred

Return: The list of loaded images

Loads a list of images from the specified file.

function getVersion¶

public String getVersion()

Get the current version of the API.

Return: The current version of the API

Retrieves the version string of the installed API.

function getFirmwareVersion¶

public String getFirmwareVersion()

Get the Firmware version of the connected Inscoper Box if available.

Exceptions:

InscoperException if an error occurred

Return: The string containing Generic Firmware version + Library version

Retrieves the firmware version string from the Inscoper Box.

function initLogger¶

public void initLogger(
    ELogMode mode,
    ELogLevel level,
    String filename,
    LogListener listener
)

Init the API logger.

Parameters:

mode : The log mode (can be combined with bitwise OR)
level : The log Level
filename : The filename of the log file if the file log mode is chosen
listener : The listener if the listener log mode is chosen

Exceptions:

InscoperException if an error occurred

Initializes the logging system for the API.

function initLogger¶

public void initLogger(
    ELogMode mode,
    ELogLevel level,
    String filename
)

Init the API logger.

Parameters:

mode : The log mode (can be combined with bitwise OR)
level : The log Level
filename : The filename of the log file if the file log mode is chosen

Exceptions:

InscoperException if an error occurred

Initializes the logging system for the API.

function initLogger¶

public void initLogger(
    ELogMode mode,
    ELogLevel level
)

Init the API logger.

Parameters:

mode : The log mode (can be combined with bitwise OR)
level : The log Level

Exceptions:

InscoperException if an error occurred

Initializes the logging system for the API.

function setLogLevel¶

public void setLogLevel(
    ELogLevel level
)

Set the log level.

Parameters:

level : The log level (TRACE, DEBUG, INFO, WARN, ERROR)

Sets the current logging level for the API.

function removeLogListener¶

public void removeLogListener(
    LogListener listener
)

Remove a log listener.

Parameters:

listener : The listener to remove

Unregisters a previously added log listener.

function getLogLevel¶

public ELogLevel getLogLevel()

Get the log level of the application.

Return: The current log level

Retrieves the current logging level of the API.

function initInscoperBoxLogger¶

public void initInscoperBoxLogger(
    ELogMode mode,
    ELogLevel level,
    String filename,
    LogListener listener
)

Init the Inscoper Box logger.

Parameters:

mode : The log mode (can be combined with bitwise OR)
level : The log Level
filename : The filename of the log file if the file log mode is chosen
listener : The listener if the listener log mode is chosen

Exceptions:

InscoperException if an error occurred

Initializes the logging system for the Inscoper Box.

function initInscoperBoxLogger¶

public void initInscoperBoxLogger(
    ELogMode mode,
    ELogLevel level,
    String filename
)

Init the Inscoper Box logger.

Parameters:

mode : The log mode (can be combined with bitwise OR)
level : The log Level
filename : The filename of the log file if the file log mode is chosen

Exceptions:

InscoperException if an error occurred

Initializes the logging system for the Inscoper Box.

function initInscoperBoxLogger¶

public void initInscoperBoxLogger(
    ELogMode mode,
    ELogLevel level
)

Init the Inscoper Box logger.

Parameters:

mode : The log mode (can be combined with bitwise OR)
level : The log Level

Exceptions:

InscoperException if an error occurred

Initializes the logging system for the Inscoper Box.

function setInscoperBoxLogLevel¶

public void setInscoperBoxLogLevel(
    ELogLevel level
)

Set the log level of the Inscoper Box.

Parameters:

level : The log level (TRACE, DEBUG, INFO, WARN, ERROR)

Sets the logging level for the Inscoper Box firmware.

function removeInscoperBoxLogListener¶

public void removeInscoperBoxLogListener(
    LogListener listener
)

Remove an Inscoper Box log listener.

Parameters:

listener : The listener to remove

Unregisters a previously added log listener for the Inscoper Box.

function getInscoperBoxLogLevel¶

public ELogLevel getInscoperBoxLogLevel()

Get the log level of the Inscoper Box firmware.

Return: The log level

Retrieves the current logging level of the Inscoper Box.

function setLogDirectory¶

public void setLogDirectory(
    String path
)

Set the log directory path.

Parameters:

path : The directory path

Sets the directory where log files will be stored.

function addErrorListener¶

public void addErrorListener(
    ErrorListener listener
)

Add an error listener.

Parameters:

listener : The listener to add

Registers a listener for error events.

function removeErrorListener¶

public void removeErrorListener(
    ErrorListener listener
)

Remove an error listener.

Parameters:

listener : The listener to remove

Unregisters a previously added error listener.

function updateFirmware¶

public void updateFirmware(
    String firmwarePath
)

Update the InscoperBox firmware.

Parameters:

firmwarePath : The path to the new firmware file

Exceptions:

InscoperException if an error occurred

Updates the firmware of the Inscoper Box using the specified file.

function connectToInscoperBox¶

public boolean connectToInscoperBox()

Connect to the Inscoper Box.

Exceptions:

InscoperException if an error occurred

Return: True if successful, false otherwise

Establishes a connection to the Inscoper Box.

function disconnectToInscoperBox¶

public boolean disconnectToInscoperBox()

Disconnect from the Inscoper Box.

Exceptions:

InscoperException if an error occurred

Return: True if successful, false otherwise

Closes the connection to the Inscoper Box.

function isConnectedToInscoperBox¶

public boolean isConnectedToInscoperBox()

Check if connected to the Inscoper Box.

Exceptions:

InscoperException if an error occurred

Return: True if connected, false otherwise

Determines if the API is currently connected to the Inscoper Box.

function restartInscoperBox¶

public void restartInscoperBox()

Restart the Inscoper Box.

Exceptions:

InscoperException if an error occurred

Restarts the Inscoper Box device.

function getInscoperBoxUsbView¶

public UsbInfoVector getInscoperBoxUsbView()

Get the USB view of the Inscoper Box.

Exceptions:

InscoperException if an error occurred

Return: The list of USB information

Retrieves information about USB devices connected to the Inscoper Box.

function resetInscoperBoxUsbView¶

public void resetInscoperBoxUsbView(
    double secondsToWaitBeforeReconnection
)

Reset the Inscoper Box USB view.

Parameters:

secondsToWaitBeforeReconnection : The time in seconds to wait before reconnecting

Exceptions:

InscoperException if an error occurred

Resets the USB view of the Inscoper Box and waits before reconnection.

function getInscoperBoxType¶

public EBoxType getInscoperBoxType()

Get the type of the Inscoper Box.

Exceptions:

InscoperException if an error occurred

Return: The box type

Retrieves the hardware type of the connected Inscoper Box.

function checkLicense¶

public boolean checkLicense()

Check if the license is valid.

Exceptions:

InscoperException if an error occurred

Return: True if valid, false otherwise

Verifies the validity of the current software license.

function setLicensePath¶

public void setLicensePath(
    String path
)

Set the path to the license file.

Parameters:

path : The license file path

Sets the path to the file containing the license information.

function hasLicenseOption¶

public boolean hasLicenseOption(
    String option
)

Check if a specific license option is available.

Parameters:

option : The option name

Exceptions:

InscoperException if an error occurred

Return: True if available, false otherwise

Determines if the specified license option is enabled.

function hasLicenseExpirationDate¶

public boolean hasLicenseExpirationDate()

Check if the license has an expiration date.

Return: True if it has an expiration date, false otherwise

Determines if the license has an expiration date.

function getLicenseDaysLeft¶

public long getLicenseDaysLeft()

Get the number of days left on the license.

Return: The number of days left

Retrieves the number of days remaining until license expiration.

function getRunSequenceSubDeviceId¶

public SubDeviceId getRunSequenceSubDeviceId()

Get the "Run Sequence" sub-device ID.

Return: The sub-device ID used for running sequences

Retrieves the sub-device ID used for coordinating sequence execution.

Protected Functions Documentation¶

function Bridge¶

protected Bridge(
    long cPtr,
    boolean cMemoryOwn
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    Bridge obj
)

function swigRelease¶

protected static long swigRelease(
    Bridge obj
)

Protected Attributes Documentation¶

variable swigCMemOwn¶

transient boolean swigCMemOwn;

Updated on 2026-04-02 at 10:55:37 +0200